CreateModelAsyncPredict - 模型异步预测API

文档自学习创建异步预测任务接口。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ModelVersionstring

模型对应的版本号,如果不传入版本号表示默认用模型最新生效的版本。

V1
BinaryToTextboolean

content 字段是图片 URL 时:false body 为 base64 的内容时:true

false:表示content传入的是url true:表示body是直接传入图片进行base64的内容
Contentstring

图片或 pdf 文件访问 URL 地址

https://doc-automl-public.oss-cn-hangzhou.aliyuncs.com/3/1559855998794593/stage/upload/20230206/oss-hlfCRJ1SorSWs10MkqxK6YcL4OVAFSv4.png?Expires=1675665563&OSSAccessKeyId=XXXX&Signature=WLKghBc3zKzWJ3Td69%2B4C21jrbE%3D
ModelIdlong

模型 ID。模型列表页模型 ID

123
ServiceNamestring

预训练服务名称

pre_train_service
ServiceVersionstring

预训练服务版本

V1
Bodystring

图片 base64 编码内容

data:image/png;base64,xxxxx

BinaryToText 为非必填项。

content 字段和 body 字段传参二选一,图片 URL 则 content 为图片访问地址。内容为 base64 编码则传参 body,且 BinaryToText 传 true。

pdf 限制 20Mb 10 页 除了长文档类型的模型预测以外,其他预测服务只会取第一页进行预测。

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

3EAC98E6-8DD6-511F-8764-DEE8B6EB6BB4
Codeinteger

请求结果状态,200 为成功

200
Messagestring

错误信息。

success
Datastring

返回数据

{ "RequestId": "292D1584-134C-1221-B9BB-1B847C623D41", "Message": "", "Data": 1, "Code": 200 }

Data 字段为创建的异步任务 ID,通过 GetModelAsyncPredict 获取结果

示例

正常返回示例

JSON格式

{
  "RequestId": "3EAC98E6-8DD6-511F-8764-DEE8B6EB6BB4",
  "Code": 200,
  "Message": "success",
  "Data": "{\n  \"RequestId\": \"292D1584-134C-1221-B9BB-1B847C623D41\",\n  \"Message\": \"\",\n  \"Data\": 1,\n  \"Code\": 200\n}"
}

错误码

HTTP status code错误码错误信息
20021002模板预测超时
20021003模板预测失败
20010001参数出错
20010005服务不存在
20016001未找到可预测的模型
20013018未找到模型信息
20016004指定的模型不存在
20023002获取资源HTTP异常
20011002账号没有开通服务
20019999未知异常

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
入参OpenAPI 入参发生变更
    新增入参:Body
    删除入参:body
2023-03-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
入参OpenAPI 入参发生变更
    新增入参:body